feat: Implement 3D flight animation methods using Vedo (Issue #523)#909
Merged
Gui-FernandesBR merged 1 commit intoJun 27, 2026
Conversation
Member
|
@GuilhermeAsura could you please fix tests and linters on CI? |
Author
I'm on it! |
Gui-FernandesBR
force-pushed
the
feature/add_animation_methods
branch
from
4a29817 to
aebdf6a
Compare
Gui-FernandesBR
left a comment
Gui-FernandesBR
left a comment
Member
There was a problem hiding this comment.
the code coverall looks good, but needs refactor.
We can still add it to the next release (this month)
Member
|
Before we merge this PR, some points should be addressed:
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #909 +/- ##
===========================================
+ Coverage 80.27% 81.24% +0.96%
===========================================
Files 104 113 +9
Lines 12769 14814 +2045
===========================================
+ Hits 10250 12035 +1785
- Misses 2519 2779 +260 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
9 tasks
Member
|
I am working on this one locally |
Member
|
@YuroCastroDev we would love to hear feedbacks from this feature. Do you think you could help us? |
Gui-FernandesBR
force-pushed
the
feature/add_animation_methods
branch
from
ab5ef3d to
292eadf
Compare
Implement 3D visualization of flight results in the plots layer using the optional `vedo` library, addressing issue RocketPy-Team#523: - `animate_trajectory`: 6-DOF translation of the rocket relative to ground. - `animate_rotate`: rocket attitude (rotation) evolution during flight. `vedo` is added as an optional dependency under the `[animation]` extra (`pip install rocketpy[animation]`); both methods raise a descriptive ImportError with install instructions when it is missing. A bundled `default_rocket.stl` asset and unit tests for the animation methods are included, along with user docs (flight, installation) and a colab cell. Originally developed by Patrick Sampaio in the legacy `animate_flight` branch and adapted to the current Flight architecture. Co-Authored-By: GuilhermeAsura <gmslazzarini@gmail.com> Co-Authored-By: Gui-FernandesBR <guilherme_fernandes@usp.br> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Gui-FernandesBR
force-pushed
the
feature/add_animation_methods
branch
from
292eadf to
a39ec8f
Compare
Gui-FernandesBR
approved these changes
Jun 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull request type
Checklist
black rocketpy/ tests/) has passed locallypytest tests -m slow --runslow) have passed locallyCHANGELOG.mdhas been updated (if relevant)Current behavior
Currently, the
Flightclass lacks built-in methods for 3D visualization of the simulation results. Users wishing to visualize the rocket's trajectory or attitude must export data and use external tools or write custom scripts. This addresses Issue #523.New behavior
This PR integrates 3D visualization capabilities directly into the
Flightclass using thevedolibrary.Key Changes:
Flight:animate_trajectory(file_name, start, stop, time_step): Visualizes the 6-DOF translation of the rocket relative to the ground.animate_rotate(file_name, start, stop, time_step): Visualizes the specific attitude (rotation) of the rocket during flight.vedoas an optional dependency inpyproject.tomlunder the[animation]key.pip install rocketpy[animation].vedoand raise a descriptiveImportErrorwith installation instructions if it is missing.animate_flightbranch to match the currentFlightclass structure (e.g., removing deprecatedpostProcesscalls).Breaking change
Additional information
Acknowledgements
This feature was originally developed by Patrick Sampaio in the
animate_flightbranch. This PR adapts that work to the moderndevelopbranch structure and newer RocketPy architecture.Verification
A modular verification suite was added in
tests/animation_verification/to generate a dummy 3D model and test the invocation of the animation methods.